<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Creates a database reference</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="mongocollection.count.html">« MongoCollection::count</a></li>
      <li style="float: right;"><a href="mongocollection.createindex.html">MongoCollection::createIndex »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.mongocollection.html">MongoCollection</a></li>
    <li>Creates a database reference</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="mongocollection.createdbref" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoCollection::createDBRef</h1>
  <p class="verinfo">(PECL mongo &gt;=0.9.0)</p><p class="refpurpose"><span class="refname">MongoCollection::createDBRef</span> &mdash; <span class="dc-title">Creates a database reference</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongocollection.createdbref-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>MongoCollection::createDBRef</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.declarations.html#language.types.declarations.mixed" class="type mixed">mixed</a></span> <code class="parameter">$document_or_id</code></span>): <span class="type">array</span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongocollection.createdbref-parameters">
  <h3 class="title">Parameters</h3>    
  <p class="para">
   <dl>

    
     <dt>

      <code class="parameter">document_or_id</code>
     </dt>

     <dd>

      <p class="para">
       If an array or object is given, its <code class="literal">_id</code> field will be
       used as the reference ID. If a <a href="class.mongoid.html" class="classname">MongoId</a> or scalar
       is given, it will be used as the reference ID.
      </p>
     </dd>

       
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongocollection.createdbref-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a database reference array.
  </p>
  <p class="para">
   If an array without an <code class="literal">_id</code> field was provided as the
   <code class="literal">document_or_id</code> parameter, <strong><code>null</code></strong> will be returned.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mongocollection.createdbref-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-97">
   <p><strong>Example #1 <span class="methodname"><strong>MongoCollection::createDBRef()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />$songs&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">songs</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$playlists&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">playlists</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">//&nbsp;create&nbsp;a&nbsp;reference&nbsp;to&nbsp;a&nbsp;song<br /></span><span style="color: #0000BB">$manamana&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$songs</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">findOne</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'title'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'Ma&nbsp;na&nbsp;ma&nbsp;na'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$refToSong&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$songs</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createDBRef</span><span style="color: #007700">(</span><span style="color: #0000BB">$manamana</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;add&nbsp;the&nbsp;reference&nbsp;to&nbsp;my&nbsp;playlist<br /></span><span style="color: #0000BB">$playlists</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">update</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'username'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'me'</span><span style="color: #007700">),&nbsp;array(</span><span style="color: #DD0000">'$push'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;array(</span><span style="color: #DD0000">'songlist'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">$refToSong</span><span style="color: #007700">)));<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongocollection.createdbref-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="methodname"><a href="mongocollection.getdbref.html" class="methodname" rel="rdfs-seeAlso">MongoCollection::getDBRef()</a> - Fetches the document pointed to by a database reference</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>